开发者中心
全部产品
产品文档
API
下载
示例代码
FAQ
API 概览
API 详情
错误码列表
Class
Class 概览
Class 详情
Interface
Interface 概览
Interface 详情
Enum
Enum 概览
Enum 详情
开发者中心 全部产品 API Android 直播 ToB Class 详情
Class 详情
Android 直播 ToB 1.0
更新时间：2023-10-10 11:52:46

KLogConfig

日志文件配置。

Declared in

属性

filePath
public String filePath

详情描述: 日志文件的完整路径。默认路径为 /storage/emulated/0/Android/data/<package name>/files/krtcsdk.log。请确保你指定的目录存在而且可写。你可通过该参数修改日志文件名。

fileSize
public int fileSize

详情描述: 单个日志文件的大小，单位为 KB。默认值为 1024 KB。如果你将 fileSize 设为 1024 KB，SDK 会最多输出总计 5 MB 的日志文件。如果你将 fileSize 设为小于 1024 KB，设置不生效，单个日志文件最大仍为 1024 KB。

level
public @KLogLevel int level

详情描述: 设置 KRTC SDK 的日志输出等级。 例如，如果你选择 WARN 级别，就可以看到在 FATAL、ERROR 和 WARN 级别上的所有日志信息。 输出日志等级请查看：KLogLevel。

logBlock
public LogBlock logBlock

详情描述:

KRtcEngineConfig

KRtcEngine 实例的配置。

Declared in KRtcEngineConfig.java

属性

mContext
public Context mContext

详情描述: 安卓活动 (Android Activity) 的上下文。

mAppId
public String mAppId

详情描述: 为 app 开发者签发的 AppID。

mHandler
public IKRtcEngineEventHandler mHandler

详情描述: IKRtcEngineEventHandler 是一个提供了缺省实现的抽象类，SDK 通过该抽象类向 App 报告 SDK 运行时的各种事件。

mLogConfig
public KLogConfig mLogConfig

详情描述: 设置 KRTC SDK 输出的日志文件。详见 KLogConfig。

VideoEncoderConfiguration

Declared in VideoEncoderConfiguration.java

属性

targetWidth
public int targetWidth

详情描述: Android 编码宽度。

targetHeight
public int targetHeight

详情描述: Android 编码高度。

frameRate
public int frameRate

详情描述: 编码帧率。

initBitrate
public int initBitrate

详情描述: 编码初始码率，sdk 会根据网络情况以初始码率为基准自动调整视频编码码率。

minBitrate
public int minBitrate

详情描述: 编码最低码率，sdk 会根据网络情况以初始码率为基准自动调整视频编码码率，但是最低不会低于这里设置的最低码率。

maxBitrate
public int maxBitrate

详情描述: 编码最高码率，sdk 会根据网络情况以初始码率为基准自动调整视频编码码率，但是最高不会超过这里设置的最高码率。

keyFrameInterval
public int keyFrameInterval

详情描述: 视频编码关键帧间隔 (GOP)，单位：秒；默认值 4 秒。

orientationMode
public int orientationMode

详情描述: 横竖屏模式

useHardwareEncoder
public boolean useHardwareEncoder

详情描述: 是否启用硬件编码。

mirror
public boolean mirror

详情描述: 编码时是否对视频做镜像处理。

enableDynamicResolution
public boolean enableDynamicResolution

详情描述: 是否根据网络或者硬件性能动态调整视频编码分辨率。

方法

videoEncoderConfiguration
public void videoEncoderConfiguration(int width, int height, int frameRate, int bitrate)

参数初始化。

参数信息
参数名 类型 描述
width int 编码宽度。
height int 编码高度。
frameRate int 编码帧率。
bitrate int 编码码率。
接口详情

返回值: 无

KVideoCanvas

Declared in KVideoCanvas.java

属性

renderMode
public int renderMode

详情描述: 视频渲染模式。

userId
public String userId

详情描述: 用户id，直播场景如果没有用户 id 可以填 0。

channelId
public String channelId

详情描述: 频道 id。

sourceType
public int sourceType

详情描述: 视频源类型。

方法

kVideoCanvas
public void kVideoCanvas(View view, @RenderMode int renderMode, String userId, String channelId, int sourceType)

初始化视频画布。

参数信息
参数名 类型 描述
view View 视频显示视窗。Android 上必须是通过 createLocalSurfaceView 或者 createLocalTextureView 创建出来的；iOS 需要设置一个 UIView。
renderMode @RenderMode int 视频渲染模式。
userId String 用户id，直播场景如果没有用户 id 可以填 0。
channelId String 频道 id。
sourceType int 视频源类型。
接口详情

返回值: 无

FaceBeautyOptions

基础美颜选项

Declared in FaceBeautyOptions.java

属性

lighteningLevel
private float lighteningLevel

详情描述: 美白级别

smoothnessLevel
private float smoothnessLevel

详情描述: 磨皮级别

方法

faceBeautyOptions
public void faceBeautyOptions()

构造函数

接口详情

返回值: 无

setLighteningLevel
public void setLighteningLevel(float level)

设置美白级别

参数信息
参数名 类型 描述
level float 美白级别, 设置范围：0 ~ 1.0
setSmoothnessLevel
public void setSmoothnessLevel(float level)

设置磨皮级别

参数信息
参数名 类型 描述
level float 磨皮级别, 设置范围：0 ~ 1.0
getLighteningLevel
public float getLighteningLevel()

getSmoothnessLevel
public float getSmoothnessLevel()

RawVideoFrame

编码前视频画面数据

Declared in KRtcEngineRawVideoFrame.java

属性

textureId
public int textureId

详情描述: 纹理id

width
public int width

详情描述: 视频帧宽度

height
public int height

详情描述: 视频帧高度

ExternalVideoFrame

外部输入视频帧。

Declared in ExternalVideoFrame.java

属性

format
public int format

详情描述: 视频帧数据格式，目前仅支持 I420 格式的 YUV 数据。

buffer
public ByteBuffer buffer

详情描述: 视频帧数据

stride
public int stride

详情描述: 视频帧 stride

height
public int height

详情描述: 视频帧高度

timestamp
public long timestamp

详情描述: 时间戳, 单位是毫秒

ExternalAudioFrame

外部输入音频帧。

Declared in ExternalAudioFrame.java

属性

format
public int format

详情描述: 音频帧数据格式，目前仅支持 S16 LE（有符号16位小端）格式。

buffer
public ByteBuffer buffer

详情描述: 音频帧数据

samples
public int samples

详情描述: 音频采样率

channels
public int channels

详情描述: 音频声道数

bytespersample
public int bytespersample

详情描述: 每个采样点的字节数

timestamp
public long timestamp

详情描述: 时间戳, 单位是毫秒

AudioVolumeInfo

音量信息。

Declared in KRtcEngineAudioVolumeInfo.java

属性

channelid
public String channelid

详情描述: 频道 ID。

uid
public String uid

详情描述: 用户 Id，"0" 表示本端用户。

volume
public int volume

详情描述: 音量 [0, 100]。

PushStats

直播推流数据指标。

Declared in KPushStats.java

属性

channelId
public String channelId

详情描述: “频道 id。"

duration
public int duration

详情描述: 推流时长

audioEncodeBitrate
public int audioEncodeBitrate

详情描述: 音频编码码率

videoEncodeBitrate
public int videoEncodeBitrate

详情描述: 视频编码码率

totalSentBytes
public int totalSentBytes

详情描述: 总的发送字节数

totalSentBitrate
public int totalSentBitrate

详情描述: 总的发送码率

videoEncodeWidth
public int videoEncodeWidth

详情描述: 视频编码宽度

videoEncodeHeight
public int videoEncodeHeight

详情描述: 视频编码高度

videoEncodeFrameRate
public int videoEncodeFrameRate

详情描述: 视频编码帧率

usingHwVideoEncoder
public boolean usingHwVideoEncoder

详情描述: 当前视频编码是否使用了硬件编码器

cpuAppUsage
public int cpuAppUsage

详情描述: 当前 App 的 CPU 使用率 (%)

cpuTotalUsage
public int cpuTotalUsage

详情描述: 当前系统的 CPU 使用率 (%)

memoryAppUsage
public int memoryAppUsage

详情描述: 当前 App 的内存占比 (%)

memoryTotalUsage
public int memoryTotalUsage

详情描述: 当前系统的内存占比 (%)

gatewayRtt
public int gatewayRtt

详情描述: 客户端到本地路由器的往返时延 (ms)

serverIp
public String serverIp

详情描述: 服务端 IP 地址。

blockCount
public int blockCount

详情描述: 推流卡顿次数。

blockDuration
public int blockDuration

详情描述: 推流卡顿时长（ms）

videoFramesDropped
public int videoFramesDropped

详情描述: 网络传输层扔掉的视频帧数

videoGop
public int videoGop

详情描述: 当前设置的GOP（秒）

vtxPreEncDly
public int vtxPreEncDly

详情描述: 视频编码前耗时

vtxPostEncDly
public int vtxPostEncDly

详情描述: 视频编码后耗时

vtxSendDly
public int vtxSendDly

详情描述: 视频发送网络耗时

atxPreEncDly
public int atxPreEncDly

详情描述: 音频编码前耗时

atxPostEncDly
public int atxPostEncDly

详情描述: 音频编码后耗时

atxSendDly
public int atxSendDly

详情描述: 音频发送网络耗时

©2024 kwairtc.com 版权所有 京ICP备19034532号-175 京公网安备 11010802038159号